<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>WorkbookUtil (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="WorkbookUtil (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WorkbookUtil.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/ss/util/SSCellRange.html" title="class in org.apache.poi.ss.util"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/ss/util/WorkbookUtil.html" target="_top">FRAMES</a></li>
<li><a href="WorkbookUtil.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.ss.util</p>
<h2 title="Class WorkbookUtil" class="title">Class WorkbookUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.ss.util.WorkbookUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>WorkbookUtil</strong>
extends java.lang.Object</pre>
<div class="block">Helper methods for when working with Usermodel Workbooks</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#WorkbookUtil()">WorkbookUtil</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String)">createSafeSheetName</a></strong>(java.lang.String&nbsp;nameProposal)</code>
<div class="block">Creates a valid sheet name, which is conform to the rules.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String, char)">createSafeSheetName</a></strong>(java.lang.String&nbsp;nameProposal,
                   char&nbsp;replaceChar)</code>
<div class="block">Creates a valid sheet name, which is conform to the rules.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#validateSheetName(java.lang.String)">validateSheetName</a></strong>(java.lang.String&nbsp;sheetName)</code>
<div class="block">Validates sheet name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#validateSheetState(int)">validateSheetState</a></strong>(int&nbsp;state)</code>
<div class="block">Validates sheet state</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="WorkbookUtil()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WorkbookUtil</h4>
<pre>public&nbsp;WorkbookUtil()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createSafeSheetName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSafeSheetName</h4>
<pre>public static final&nbsp;java.lang.String&nbsp;createSafeSheetName(java.lang.String&nbsp;nameProposal)</pre>
<div class="block">Creates a valid sheet name, which is conform to the rules.
 In any case, the result safely can be used for 
 <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetName(int, java.lang.String)"><code>Workbook.setSheetName(int, String)</code></a>.
 <br>
 Rules:
 <ul>
 <li>never null</li>
 <li>minimum length is 1</li>
 <li>maximum length is 31</li>
 <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
 <li>Sheet names must not begin or end with ' (apostrophe)</li>
 </ul>
 Invalid characters are replaced by one space character ' '.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nameProposal</code> - can be any string, will be truncated if necessary,
        allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a valid string, "empty" if to short, "null" if null</dd></dl>
</li>
</ul>
<a name="createSafeSheetName(java.lang.String, char)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSafeSheetName</h4>
<pre>public static final&nbsp;java.lang.String&nbsp;createSafeSheetName(java.lang.String&nbsp;nameProposal,
                                   char&nbsp;replaceChar)</pre>
<div class="block">Creates a valid sheet name, which is conform to the rules.
 In any case, the result safely can be used for
 <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetName(int, java.lang.String)"><code>Workbook.setSheetName(int, String)</code></a>.
 <br>
 Rules:
 <ul>
 <li>never null</li>
 <li>minimum length is 1</li>
 <li>maximum length is 31</li>
 <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
 <li>Sheet names must not begin or end with ' (apostrophe)</li>
 </ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nameProposal</code> - can be any string, will be truncated if necessary,
        allowed to be null</dd><dd><code>replaceChar</code> - the char to replace invalid characters.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a valid string, "empty" if to short, "null" if null</dd></dl>
</li>
</ul>
<a name="validateSheetName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateSheetName</h4>
<pre>public static&nbsp;void&nbsp;validateSheetName(java.lang.String&nbsp;sheetName)</pre>
<div class="block">Validates sheet name.

 <p>
 The character count <tt>MUST</tt> be greater than or equal to 1 and less than or equal to 31.
 The string MUST NOT contain the any of the following characters:
 <ul>
 <li> 0x0000 </li>
 <li> 0x0003 </li>
 <li> colon (:) </li>
 <li> backslash (\) </li>
 <li> asterisk (*) </li>
 <li> question mark (?) </li>
 <li> forward slash (/) </li>
 <li> opening square bracket ([) </li>
 <li> closing square bracket (]) </li>
 </ul>
 The string MUST NOT begin or end with the single quote (') character.
 </p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetName</code> - the name to validate</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if validation fails</dd></dl>
</li>
</ul>
<a name="validateSheetState(int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validateSheetState</h4>
<pre>public static&nbsp;void&nbsp;validateSheetState(int&nbsp;state)</pre>
<div class="block">Validates sheet state</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the state to validate</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if state is not one of
      <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_VISIBLE"><code>Workbook.SHEET_STATE_VISIBLE</code></a>,
      <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_HIDDEN"><code>Workbook.SHEET_STATE_HIDDEN</code></a> or
      <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_VERY_HIDDEN"><code>Workbook.SHEET_STATE_VERY_HIDDEN</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WorkbookUtil.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/ss/util/SSCellRange.html" title="class in org.apache.poi.ss.util"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/ss/util/WorkbookUtil.html" target="_top">FRAMES</a></li>
<li><a href="WorkbookUtil.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
